API for configuring and manipulating LTE IoT 16 Click driver. More...

Topics
	LTE IoT 16 Device Settings
	Settings for registers of LTE IoT 16 Click driver.
	LTE IoT 16 MikroBUS Map
	MikroBUS pin mapping of LTE IoT 16 Click driver.

Functions
void	lteiot16_cfg_setup (lteiot16_cfg_t *cfg)
	LTE IoT 16 configuration object setup function.
err_t	lteiot16_init (lteiot16_t ctx, lteiot16_cfg_t cfg)
	LTE IoT 16 initialization function.
err_t	lteiot16_generic_write (lteiot16_t ctx, uint8_t data_in, uint16_t len)
	LTE IoT 16 data writing function.
err_t	lteiot16_generic_read (lteiot16_t ctx, uint8_t data_out, uint16_t len)
	LTE IoT 16 data reading function.
void	lteiot16_set_pwr_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set PWR pin function.
void	lteiot16_set_rst_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set RST pin function.
void	lteiot16_set_rts_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set RTS pin function.
uint8_t	lteiot16_get_ring_pin (lteiot16_t *ctx)
	LTE IoT 16 get RING pin function.
uint8_t	lteiot16_get_cts_pin (lteiot16_t *ctx)
	LTE IoT 16 get CTS pin function.
void	lteiot16_set_power_state (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set power state function.
void	lteiot16_cmd_run (lteiot16_t ctx, uint8_t cmd)
	LTE IoT 16 cmd run function.
void	lteiot16_cmd_set (lteiot16_t ctx, uint8_t cmd, uint8_t *value)
	LTE IoT 16 cmd set function.
void	lteiot16_cmd_get (lteiot16_t ctx, uint8_t cmd)
	LTE IoT 16 cmd get function.
void	lteiot16_cmd_help (lteiot16_t ctx, uint8_t cmd)
	LTE IoT 16 cmd help function.
void	lteiot16_set_sim_apn (lteiot16_t ctx, uint8_t sim_apn)
	Set sim card APN.
void	lteiot16_send_sms_text (lteiot16_t ctx, uint8_t phone_number, uint8_t *sms_text)
	LTE IoT 16 send SMS in text mode.
err_t	lteiot16_send_sms_pdu (lteiot16_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	LTE IoT 16 send SMS in PDU mode.
err_t	lteiot16_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	LTE IoT 16 parse GGA function.

Detailed Description

API for configuring and manipulating LTE IoT 16 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ lteiot16_cfg_setup()

void lteiot16_cfg_setup ( lteiot16_cfg_t * cfg )

LTE IoT 16 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See lteiot16_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ lteiot16_cmd_get()

void lteiot16_cmd_get	(	lteiot16_t *	ctx,
		uint8_t *	cmd )

LTE IoT 16 cmd get function.

This function is used to get the value of a given command from the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ lteiot16_cmd_help()

void lteiot16_cmd_help	(	lteiot16_t *	ctx,
		uint8_t *	cmd )

LTE IoT 16 cmd help function.

This function provides a short description of the given command of the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ lteiot16_cmd_run()

void lteiot16_cmd_run	(	lteiot16_t *	ctx,
		uint8_t *	cmd )

LTE IoT 16 cmd run function.

This function sends a specified command to the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ lteiot16_cmd_set()

void lteiot16_cmd_set	(	lteiot16_t *	ctx,
		uint8_t *	cmd,
		uint8_t *	value )

LTE IoT 16 cmd set function.

This function sets a value to a specified command of the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	cmd	: Command string.
[in]	value	: Value string.

Returns: None.

Note: None.

◆ lteiot16_generic_read()

err_t lteiot16_generic_read	(	lteiot16_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

LTE IoT 16 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

>0 - Number of data bytes read,
<=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note: None.

◆ lteiot16_generic_write()

err_t lteiot16_generic_write	(	lteiot16_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

LTE IoT 16 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ lteiot16_get_cts_pin()

uint8_t lteiot16_get_cts_pin ( lteiot16_t * ctx )

LTE IoT 16 get CTS pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters

[in] ctx : Click context object. See lteiot16_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ lteiot16_get_ring_pin()

uint8_t lteiot16_get_ring_pin ( lteiot16_t * ctx )

LTE IoT 16 get RING pin function.

This function returns the ring indication (RING) pin logic state.

Parameters

[in] ctx : Click context object. See lteiot16_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ lteiot16_init()

err_t lteiot16_init	(	lteiot16_t *	ctx,
		lteiot16_cfg_t *	cfg )

LTE IoT 16 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See lteiot16_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ lteiot16_parse_gga()

err_t lteiot16_parse_gga	(	uint8_t *	rsp_buf,
		uint8_t	gga_element,
		uint8_t *	element_data )

LTE IoT 16 parse GGA function.

This function parses the GGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gga_element	: GGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ lteiot16_send_sms_pdu()

err_t lteiot16_send_sms_pdu	(	lteiot16_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 16 send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	service_center_number	: SMSC of the SIM card.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ lteiot16_send_sms_text()

void lteiot16_send_sms_text	(	lteiot16_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 16 send SMS in text mode.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns: Nothing.

Note: None.

◆ lteiot16_set_power_state()

void lteiot16_set_power_state	(	lteiot16_t *	ctx,
		uint8_t	state )

LTE IoT 16 set power state function.

This function sets a desired power state by toggling PWR and RST pins with a specific timing.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	state	: `0` - Power OFF, `1` - Power ON, `2` - Reset.

Returns: None.

Note: None.

◆ lteiot16_set_pwr_pin()

void lteiot16_set_pwr_pin	(	lteiot16_t *	ctx,
		uint8_t	state )

LTE IoT 16 set PWR pin function.

This function sets the PWRKEY pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ lteiot16_set_rst_pin()

void lteiot16_set_rst_pin	(	lteiot16_t *	ctx,
		uint8_t	state )

LTE IoT 16 set RST pin function.

This function sets the RESET pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ lteiot16_set_rts_pin()

void lteiot16_set_rts_pin	(	lteiot16_t *	ctx,
		uint8_t	state )

LTE IoT 16 set RTS pin function.

This function sets the request to send (RTS) pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ lteiot16_set_sim_apn()

void lteiot16_set_sim_apn	(	lteiot16_t *	ctx,
		uint8_t *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See lteiot16_t object definition for detailed explanation.
[in]	sim_apn	: SIM card APN.

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ lteiot16_cfg_setup()

◆ lteiot16_cmd_get()

◆ lteiot16_cmd_help()

◆ lteiot16_cmd_run()

◆ lteiot16_cmd_set()

◆ lteiot16_generic_read()

◆ lteiot16_generic_write()

◆ lteiot16_get_cts_pin()

◆ lteiot16_get_ring_pin()

◆ lteiot16_init()

◆ lteiot16_parse_gga()

◆ lteiot16_send_sms_pdu()

◆ lteiot16_send_sms_text()

◆ lteiot16_set_power_state()

◆ lteiot16_set_pwr_pin()

◆ lteiot16_set_rst_pin()

◆ lteiot16_set_rts_pin()

◆ lteiot16_set_sim_apn()